Vcenter Vm Guest Credentials

Vcenter Vm Guest Credentials

The Vcenter Vm Guest Credentials schema defines the guest credentials used for guest operation authentication.

This schema was added in vSphere API 7.0.2.0.

JSON Example

{
    "interactive_session": false,
    "type": "string",
    "user_name": "string",
    "password": "string",
    "saml_token": "string"
}

boolean

interactive_session

Required

If set, the operation will interact with the logged-in desktop session in the guest. This requires that the logged-on user matches the user specified by the Vcenter Vm Guest Credentials. This is currently only supported for Vcenter Vm Guest Credentials Type.USERNAME_PASSWORD.

This property was added in vSphere API 7.0.2.0.

string

type

Required

The guest credentials type

For more information see: Vcenter Vm Guest Credentials Type.

This property was added in vSphere API 7.0.2.0.

string

user_name

Optional

For Vcenter Vm Guest Credentials Type.SAML_BEARER_TOKEN, this is the guest user to be associated with the credentials. For Vcenter Vm Guest Credentials Type.USERNAME_PASSWORD this is the guest username.

This property was added in vSphere API 7.0.2.0.

If no user is specified for Vcenter Vm Guest Credentials Type.SAML_BEARER_TOKEN, a guest dependent mapping will decide what guest user account is applied.

string As password As password

password

Optional

password

This property was added in vSphere API 7.0.2.0.

This property is optional and it is only relevant when the value of type is Vcenter Vm Guest Credentials Type.USERNAME_PASSWORD.

string As password As password

saml_token

Optional

SAML Bearer Token

This property was added in vSphere API 7.0.2.0.

This property is optional and it is only relevant when the value of type is Vcenter Vm Guest Credentials Type.SAML_BEARER_TOKEN.